Get DialPlans

This request retrieves all dialplans for a specific location.

URI

Copy

{{baseUrl}}/api/v2/customer/{{customerId}}/sitelocation/{{siteLocationId}}/dialplan/{dialplanId}

HTTP Method

GET

Request Parameters

Parameters	Type	Description
customerGuid	string($uuid)	Unique customer 'Id' created when customer is added. Extract this value from Get Services Brief Details (V3) request.
sitelocationGuid	string($uuid)	Unique Id for customer location. When customers have a single site, this value is identical to Customer 'Id' above. Extract this value from Get Services Brief Details (V3) request.
dialplanId	string($uuid)	The dialplan name. For example, CustDialPlan.
All Details	Boolean Default: false	When enables retrieves additional details for each dial plan.

Example Response

Copy

[
    {
        "dialPlanId": "CustDialPlan",
        "ruleDTO": []
    },
    {
        "dialPlanId": "RegisteredUsers",
        "ruleDTO": []
    },
    {
        "dialPlanId": "Zoom",
        "ruleDTO": []
    },
    {
        "dialPlanId": "OCDialPlan",
        "ruleDTO": []
    }
]

The following output example indicates when no dial plan is selected.

Copy

[
    {
        "dialPlanId": "CustDialPlan",
        "ruleDTO": []
    },
    {
        "dialPlanId": "RegisteredUsers",
        "ruleDTO": []
    },
    {
        "dialPlanId": "Zoom",
        "ruleDTO": []
    },
    {
        "dialPlanId": "OCDialPlan",
        "ruleDTO": []
    }
]

HTTP Responses

■

200 OK

Parameter	Type	Description
dialPlanId	string	The Dial plan name.
RuleDTO
name	string	The name of the dial plan rule.
prefix	string	The calling prefixes to add for users for this site location. For example "{{+019123854567}}".
tag	string	The Derived Trunk FQDN of the SBC device used to manage calls for this site location. For example, "{{EMEA.Customers.AudioCodes.com}}" If a number is added with a tag that is not an AudioCodes SBC PSTN gateway, then for the purpose of User licensing calculations, its counted as a Service Number license factor. For more information, see User Licenses.